home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / XmPushButton.z / XmPushButton
Encoding:
Text File  |  1998-10-20  |  44.7 KB  |  595 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn - The PushButton widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////PPPPuuuusssshhhhBBBB....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           PushButton issues commands within an application.  It
  20.           consists of a text label or pixmap surrounded by a border
  21.           shadow.  When a PushButton is selected, the shadow changes
  22.           to give the appearance that it has been pressed in.  When a
  23.           PushButton is unselected, the shadow changes to give the
  24.           appearance that it is out.
  25.  
  26.           The default behavior associated with a PushButton in a menu
  27.           depends on the type of menu system in which it resides.  By
  28.           default, BBBBSSSSeeeelllleeeecccctttt controls the behavior of the PushButton.
  29.           In addition, BBBBMMMMeeeennnnuuuu controls the behavior of the PushButton
  30.           if it resides in a PopupMenu system.  The actual mouse
  31.           button used is determined by its RowColumn parent.
  32.  
  33.           Thickness for a second shadow, used when the PushButton is
  34.           the default button,  may be specified by using the
  35.           XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt resource.  If it has a non-zero value, the
  36.           Label's resources XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnLLLLeeeefffftttt, XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnRRRRiiiigggghhhhtttt,
  37.           XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnTTTToooopppp, and XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnBBBBoooottttttttoooommmm may be modified to
  38.           accommodate the second shadow.
  39.  
  40.           If an initial value is specified for XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp but not
  41.           for XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp value is used for
  42.           XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp.
  43.  
  44.         CCCCllllaaaasssssssseeeessss
  45.           PushButton inherits behavior and resources from CCCCoooorrrreeee,
  46.           XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee, and XXXXmmmmLLLLaaaabbbbeeeellll Classes.
  47.  
  48.           The class pointer is xxxxmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  49.  
  50.           The class name is XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn.
  51.  
  52.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  53.           The following table defines a set of widget resources used
  54.           by the programmer to specify data.  The programmer can also
  55.           set the resource values for the inherited classes to set
  56.           attributes for this widget.  To reference a resource by name
  57.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  58.           prefix and use the remaining letters.  To specify one of the
  59.           defined values for a resource in a .Xdefaults file, remove
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           the XXXXmmmm prefix and use the remaining letters (in either
  75.           lowercase or uppercase, but include any underscores between
  76.           words).  The codes in the access column indicate if the
  77.           given resource can be set at creation time (C), set by using
  78.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  79.           not applicable (N/A).
  80.  
  81.                                                  XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  82.      NNNNaaaammmmeeee                              CCCCllllaaaassssssss                             TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  83.      __________________________________________________________________________________________________________________
  84.      XmNactivateCallback               XmCCallback                       XtCallbackList   NULL                   C
  85.      XmNarmCallback                    XmCCallback                       XtCallbackList   NULL                   C
  86.      XmNarmColor                       XmCArmColor                       Pixel            dynamic                CSG
  87.      XmNarmPixmap                      XmCArmPixmap                      Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  88.      XmNdefaultButtonShadowThickness   XmCDefaultButtonShadowThickness   Dimension        dynamic                CSG
  89.      XmNdisarmCallback                 XmCCallback                       XtCallbackList   NULL                   C
  90.      XmNfillOnArm                      XmCFillOnArm                      Boolean          True                   CSG
  91.      XmNmultiClick                     XmCMultiClick                     unsigned char    dynamic                CSG
  92.      XmNshowAsDefault                  XmCShowAsDefault                  Dimension        0                      CSG
  93.  
  94.  
  95.           XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk
  96.                     Specifies the list of callbacks that is called
  97.                     when PushButton is activated.  PushButton is
  98.                     activated when the user presses and releases the
  99.                     active mouse button while the pointer is inside
  100.                     that widget.  Activating the PushButton also
  101.                     disarms it.  For this callback the reason is
  102.                     XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE.
  103.  
  104.           XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  105.                     Specifies the list of callbacks that is called
  106.                     when PushButton is armed.  PushButton is armed
  107.                     when the user presses the active mouse button
  108.                     while the pointer is inside that widget.  For this
  109.                     callback the reason is XXXXmmmmCCCCRRRR____AAAARRRRMMMM.
  110.  
  111.           XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr
  112.                     Specifies the color with which to fill the armed
  113.                     button.  XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm must be set to True for this
  114.                     resource to have an effect.  The default for a
  115.                     color display is a color between the background
  116.                     and the bottom shadow color.  For a monochrome
  117.                     display, the default is set to the foreground
  118.                     color, and any text in the label appears in the
  119.                     background color when the button is armed.
  120.  
  121.           XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp
  122.                     Specifies the pixmap to be used as the button face
  123.                     if XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP and PushButton is
  124.                     armed.  This resource is disabled when the
  125.                     PushButton is in a menu.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           XXXXmmmmNNNNddddeeeeffffaaaauuuullllttttBBBBuuuuttttttttoooonnnnSSSShhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss
  141.                     This resource specifies the width of the default
  142.                     button indicator shadow.  If this resource is
  143.                     zero, the width of the shadow comes from the value
  144.                     of the XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt resource.  If this
  145.                     resource is greater than zero, the
  146.                     XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt resource is only used to specify
  147.                     whether this button is the default.  The default
  148.                     value is the initial value of XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt.
  149.  
  150.           XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  151.                     Specifies the list of callbacks that is called
  152.                     when PushButton is disarmed.  PushButton is
  153.                     disarmed when the user presses and releases the
  154.                     active mouse button while the pointer is inside
  155.                     that widget.  For this callback, the reason is
  156.                     XXXXmmmmCCCCRRRR____DDDDIIIISSSSAAAARRRRMMMM.
  157.  
  158.           XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm
  159.                     Forces the PushButton to fill the background of
  160.                     the button with the color specified by XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr
  161.                     when the button is armed and when this resource is
  162.                     set to True.  If False, only the top and bottom
  163.                     shadow colors are switched.  When the PushButton
  164.                     is in a menu, this resource is ignored and assumed
  165.                     to be False.
  166.  
  167.           XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk
  168.                     If a button click is followed by another button
  169.                     click within the time span specified by the
  170.                     display's multi-click time, and this resource is
  171.                     set to XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, do not process the
  172.                     second click.  If this resource is set to
  173.                     XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, process the event and increment
  174.                     _c_l_i_c_k__c_o_u_n_t in the callback structure.  When the
  175.                     button is in a menu, the default is
  176.                     XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD; otherwise, for a button not
  177.                     in a menu, XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP is the default value.
  178.  
  179.           XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt
  180.                     If XXXXmmmmNNNNddddeeeeffffaaaauuuullllttttBBBBuuuuttttttttoooonnnnSSSShhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss is greater than
  181.                     zero, a value greater than zero in this resource
  182.                     specifies to mark this button as the default
  183.                     button.  If XXXXmmmmNNNNddddeeeeffffaaaauuuullllttttBBBBuuuuttttttttoooonnnnSSSShhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss is
  184.                     zero, a value greater than zero in this resource
  185.                     specifies to mark this button as the default
  186.                     button with the shadow thickness specified by this
  187.                     resource.  The space between the shadow and the
  188.                     default shadow is equal to the sum of both
  189.                     shadows.  The default value is zero.  When this
  190.                     value is not zero, the Label resources
  191.                     XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnLLLLeeeefffftttt, XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnRRRRiiiigggghhhhtttt, XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnTTTToooopppp, and
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                     XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnBBBBoooottttttttoooommmm may be modified to accommodate the
  207.                     second shadow.  This resource is disabled when the
  208.                     PushButton is in a menu.
  209.  
  210.  
  211.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  212.           PushButton inherits behavior and resources from the
  213.           following superclasses.  For a complete description of each
  214.           resource, refer to the man page for that superclass.
  215.  
  216.                                                 XXXXmmmmLLLLaaaabbbbeeeellll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  217.      NNNNaaaammmmeeee                        CCCCllllaaaassssssss                       TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                  AAAAcccccccceeeessssssss
  218.      ___________________________________________________________________________________________________________
  219.      XmNaccelerator              XmCAccelerator              String              NULL                     CSG
  220.      XmNacceleratorText          XmCAcceleratorText          XmString            NULL                     CSG
  221.      XmNalignment                XmCAlignment                unsigned char       dynamic                  CSG
  222.      XmNfontList                 XmCFontList                 XmFontList          dynamic                  CSG
  223.      XmNlabelInsensitivePixmap   XmCLabelInsensitivePixmap   Pixmap              XmUNSPECIFIED_PIXMAP     CSG
  224.      XmNlabelPixmap              XmCLabelPixmap              Pixmap              dynamic                  CSG
  225.      XmNlabelString              XmCXmString                 XmString            dynamic                  CSG
  226.      XmNlabelType                XmCLabelType                unsigned char       XmSTRING                 CSG
  227.      XmNmarginBottom             XmCMarginBottom             Dimension           dynamic                  CSG
  228.      XmNmarginHeight             XmCMarginHeight             Dimension           2                        CSG
  229.      XmNmarginLeft               XmCMarginLeft               Dimension           dynamic                  CSG
  230.      XmNmarginRight              XmCMarginRight              Dimension           dynamic                  CSG
  231.      XmNmarginTop                XmCMarginTop                Dimension           dynamic                  CSG
  232.      XmNmarginWidth              XmCMarginWidth              Dimension           2                        CSG
  233.      XmNmnemonic                 XmCMnemonic                 KeySym              NULL                     CSG
  234.      XmNmnemonicCharSet          XmCMnemonicCharSet          String              XmFONTLIST_DEFAULT_TAG   CSG
  235.      XmNrecomputeSize            XmCRecomputeSize            Boolean             True                     CSG
  236.      XmNstringDirection          XmCStringDirection          XmStringDirection   dynamic                  CSG
  237.  
  238.                                          XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  239.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  240.      ________________________________________________________________________________________________
  241.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic                CSG
  242.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap             XmUNSPECIFIED_PIXMAP   CSG
  243.      XmNforeground           XmCForeground           Pixel              dynamic                CSG
  244.      XmNhelpCallback         XmCCallback             XtCallbackList     NULL                   C
  245.      XmNhighlightColor       XmCHighlightColor       Pixel              dynamic                CSG
  246.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False                  CSG
  247.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap             dynamic                CSG
  248.      XmNhighlightThickness   XmCHighlightThickness   Dimension          2                      CSG
  249.      XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE                 CSG
  250.      XmNshadowThickness      XmCShadowThickness      Dimension          2                      CSG
  251.      XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic                CSG
  252.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap             dynamic                CSG
  253.      XmNtraversalOn          XmCTraversalOn          Boolean            True                   CSG
  254.      XmNunitType             XmCUnitType             unsigned char      dynamic                CSG
  255.      XmNuserData             XmCUserData             XtPointer          NULL                   CSG
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  269.  
  270.  
  271.  
  272.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  273.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  274.      ______________________________________________________________________________________________________________
  275.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  276.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  277.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  278.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  279.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  280.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  281.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  282.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  283.      XmNdepth                        XmCDepth                        int              dynamic                CG
  284.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  285.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  286.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  287.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  288.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  289.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  290.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  291.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  292.      XmNx                            XmCPosition                     Position         0                      CSG
  293.      XmNy                            XmCPosition                     Position         0                      CSG
  294.  
  295.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  296.           A pointer to the following structure is passed to each
  297.           callback:
  298.  
  299.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  300.           {{{{
  301.             iiiinnnntttt      _r_e_a_s_o_n;;;;
  302.             XXXXEEEEvvvveeeennnntttt   * _e_v_e_n_t;;;;
  303.             iiiinnnntttt      _c_l_i_c_k__c_o_u_n_t;;;;
  304.           }}}} XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
  305.  
  306.  
  307.           _r_e_a_s_o_n Indicates why the callback was invoked.
  308.  
  309.           _e_v_e_n_t  Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback.
  310.  
  311.           _c_l_i_c_k__c_o_u_n_t
  312.                  This value is valid only when the reason is
  313.                  XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE.  It contains the number of clicks in
  314.                  the last multiclick sequence if the XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk
  315.                  resource is set to XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, otherwise it
  316.                  contains 1111.  The activate callback is invoked for
  317.                  each click if XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is set to
  318.                  XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP.
  319.  
  320.  
  321.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  322.           XmPushButton includes translations from Primitive.
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  335.  
  336.  
  337.  
  338.           Note that altering translations in ####oooovvvveeeerrrrrrrriiiiddddeeee or ####aaaauuuuggggmmmmeeeennnntttt
  339.           mode is undefined.
  340.  
  341.           Additional XmPushButton translations for XmPushButtons not
  342.           in a menu system are listed below.  These translations may
  343.           not directly correspond to a translation table.
  344.  
  345.           BBBBDDDDrrrraaaagggg PPPPrrrreeeessssssss::::   PPPPrrrroooocccceeeessssssssDDDDrrrraaaagggg(((())))
  346.  
  347.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss:::: AAAArrrrmmmm(((())))
  348.           BBBBSSSSeeeelllleeeecccctttt CCCClllliiiicccckkkk:::: AAAAccccttttiiiivvvvaaaatttteeee(((())))
  349.                          DDDDiiiissssaaaarrrrmmmm(((())))
  350.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee::::AAAAccccttttiiiivvvvaaaatttteeee(((())))
  351.                          DDDDiiiissssaaaarrrrmmmm(((())))
  352.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss 2222++++::::MMMMuuuullllttttiiiiAAAArrrrmmmm(((())))
  353.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee 2222++++::::MMMMuuuullllttttiiiiAAAAccccttttiiiivvvvaaaatttteeee(((())))
  354.                          DDDDiiiissssaaaarrrrmmmm(((())))
  355.           KKKKSSSSeeeelllleeeecccctttt::::       AAAArrrrmmmmAAAAnnnnddddAAAAccccttttiiiivvvvaaaatttteeee(((())))
  356.           KKKKHHHHeeeellllpppp::::         HHHHeeeellllpppp(((())))
  357.  
  358.  
  359.           XmPushButton inherits menu traversal translations from
  360.           XmLabel.  Additional XmPushButton translations for
  361.           PushButtons in a menu system are listed below.  In a Popup
  362.           menu system, BBBBMMMMeeeennnnuuuu also performs the BBBBSSSSeeeelllleeeecccctttt actions.  These
  363.           translations may not directly correspond to a translation
  364.           table.
  365.  
  366.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss:::: BBBBttttnnnnDDDDoooowwwwnnnn(((())))
  367.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee::::BBBBttttnnnnUUUUpppp(((())))
  368.           KKKKAAAAccccttttiiiivvvvaaaatttteeee::::     AAAArrrrmmmmAAAAnnnnddddAAAAccccttttiiiivvvvaaaatttteeee(((())))
  369.           KKKKSSSSeeeelllleeeecccctttt::::       AAAArrrrmmmmAAAAnnnnddddAAAAccccttttiiiivvvvaaaatttteeee(((())))
  370.           MMMMAAAAnnnnyyyy KKKKCCCCaaaannnncccceeeellll::::  MMMMeeeennnnuuuuSSSShhhheeeellllllllPPPPooooppppddddoooowwwwnnnnOOOOnnnneeee(((())))
  371.  
  372.  
  373.         AAAAccccttttiiiioooonnnn RRRRoooouuuuttttiiiinnnneeeessss
  374.           The XmPushButton action routines are described below:
  375.  
  376.  
  377.           AAAAccccttttiiiivvvvaaaatttteeee(((()))):
  378.                     This action draws the shadow in the unarmed state.
  379.                     If the button is not in a menu and if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm
  380.                     is set to True, the background color reverts to
  381.                     the unarmed color.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP,
  382.                     the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is used for the button face.
  383.                     If the pointer is still within the button, this
  384.                     action calls the callbacks for
  385.                     XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk.
  386.  
  387.           AAAArrrrmmmm(((()))):    This action arms the PushButton.  It draws the
  388.                     shadow in the armed state.  If the button is not
  389.                     in a menu and if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, it
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 4/30/98)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  401.  
  402.  
  403.  
  404.                     fills the button with the color specified by
  405.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the
  406.                     XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp is used for the button face.  It
  407.                     calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  408.  
  409.           AAAArrrrmmmmAAAAnnnnddddAAAAccccttttiiiivvvvaaaatttteeee(((()))):
  410.                     In a menu, does the following:  Unposts all menus
  411.                     in the menu hierarchy.  Unless the button is
  412.                     already armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  413.                     Calls the XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk and
  414.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  415.  
  416.                     Outside a menu, does the following:  Draws the
  417.                     shadow in the armed state and, if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is
  418.                     set to True, fills the button with the color
  419.                     specified by XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is
  420.                     XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp is used for the button
  421.                     face.  Calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  422.  
  423.                     Outside a menu, this action also arranges for the
  424.                     following to happen, either immediately or at a
  425.                     later time:  The shadow is drawn in the unarmed
  426.                     state and, if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, the
  427.                     background color reverts to the unarmed color.  If
  428.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  429.                     used for the button face.  The XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk
  430.                     and XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks are called.
  431.  
  432.           BBBBttttnnnnDDDDoooowwwwnnnn(((()))):
  433.                     This action unposts any menus posted by the
  434.                     PushButton's parent menu, disables keyboard
  435.                     traversal for the menu, and enables mouse
  436.                     traversal for the menu.  It draws the shadow in
  437.                     the armed state and, unless the button is already
  438.                     armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  439.  
  440.           BBBBttttnnnnUUUUpppp(((()))):  This action unposts all menus in the menu
  441.                     hierarchy and activates the PushButton.  It calls
  442.                     the XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk callbacks and then the
  443.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  444.  
  445.           DDDDiiiissssaaaarrrrmmmm(((()))): Calls the callbacks for XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  446.  
  447.           HHHHeeeellllpppp(((()))):   In a Pulldown or Popup MenuPane, unposts all menus
  448.                     in the menu hierarchy and, when the shell's
  449.                     keyboard focus policy is XXXXmmmmEEEEXXXXPPPPLLLLIIIICCCCTTTT, restores
  450.                     keyboard focus to the widget that had the focus
  451.                     before the menu system was entered.  Calls the
  452.                     callbacks for XXXXmmmmNNNNhhhheeeellllppppCCCCaaaallllllllbbbbaaaacccckkkk if any exist.  If
  453.                     there are no help callbacks for this widget, this
  454.                     action calls the help callbacks for the nearest
  455.                     ancestor that has them.
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 4/30/98)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  467.  
  468.  
  469.  
  470.           MMMMeeeennnnuuuuSSSShhhheeeellllllllPPPPooooppppddddoooowwwwnnnnOOOOnnnneeee(((()))):
  471.                     In a toplevel Pulldown MenuPane from a MenuBar,
  472.                     unposts the menu, disarms the MenuBar
  473.                     CascadeButton and the MenuBar, and, when the
  474.                     shell's keyboard focus policy is XXXXmmmmEEEEXXXXPPPPLLLLIIIICCCCTTTT,
  475.                     restores keyboard focus to the widget that had the
  476.                     focus before the MenuBar was entered.  In other
  477.                     Pulldown MenuPanes, unposts the menu.
  478.  
  479.                     In a Popup MenuPane, unposts the menu and restores
  480.                     keyboard focus to the widget from which the menu
  481.                     was posted.
  482.  
  483.           MMMMuuuullllttttiiiiAAAAccccttttiiiivvvvaaaatttteeee(((()))):
  484.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, this
  485.                     action does nothing.
  486.  
  487.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, this action
  488.                     does the following:  Increments _c_l_i_c_k__c_o_u_n_t in the
  489.                     callback structure.  Draws the shadow in the
  490.                     unarmed state.  If the button is not in a menu and
  491.                     if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, the background
  492.                     color reverts to the unarmed color.  If
  493.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  494.                     used for the button face.  If the pointer is
  495.                     within the PushButton, calls the callbacks for
  496.                     XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk.  Calls the callbacks for
  497.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  498.  
  499.           MMMMuuuullllttttiiiiAAAArrrrmmmm(((()))):
  500.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, this
  501.                     action does nothing.
  502.  
  503.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, this action
  504.                     does the following:  Draws the shadow in the armed
  505.                     state.  If the button is not in a menu and if
  506.                     XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, fills the button with
  507.                     the color specified by XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr.  If
  508.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp is used
  509.                     for the button face.  Calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  510.                     callbacks.
  511.  
  512.           PPPPrrrroooocccceeeessssssssDDDDrrrraaaagggg(((()))):
  513.                     Drags the contents of a PushButton label,
  514.                     identified by pressing BBBBDDDDrrrraaaagggg.  This action creates
  515.                     a DragContext object whose XXXXmmmmNNNNeeeexxxxppppoooorrrrttttTTTTaaaarrrrggggeeeettttssss
  516.                     resource is set to "COMPOUND_TEXT" for a label
  517.                     type of XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG; otherwise, "PIXMAP" if the label
  518.                     type is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP.  This action is undefined for
  519.                     PushButtons used in a menu system.
  520.  
  521.  
  522.  
  523.  
  524.  
  525.      Page 8                                          (printed 4/30/98)
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  533.  
  534.  
  535.  
  536.         AAAAddddddddiiiittttiiiioooonnnnaaaallll BBBBeeeehhhhaaaavvvviiiioooorrrr
  537.           This widget has the additional behavior described below:
  538.  
  539.  
  540.           <<<<EEEEnnnntttteeeerrrrWWWWiiiinnnnddddoooowwww>>>>:
  541.                     In a menu, if keyboard traversal is enabled, this
  542.                     action does nothing.  Otherwise, it draws the
  543.                     shadow in the armed state and calls the
  544.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  545.  
  546.                     If the PushButton is not in a menu and the cursor
  547.                     leaves and then reenters the PushButton's window
  548.                     while the button is pressed, this action draws the
  549.                     shadow in the armed state.  If XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set
  550.                     to True, it also fills the button with the color
  551.                     specified by XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is
  552.                     XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp is used for the button
  553.                     face.
  554.  
  555.           <<<<LLLLeeeeaaaavvvveeeeWWWWiiiinnnnddddoooowwww>>>>:
  556.                     In a menu, if keyboard traversal is enabled, this
  557.                     action does nothing.  Otherwise, it draws the
  558.                     shadow in the unarmed state and calls the
  559.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  560.  
  561.                     If the PushButton is not in a menu and the cursor
  562.                     leaves the PushButton's window while the button is
  563.                     pressed, this action draws the shadow in the
  564.                     unarmed state.  If XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True,
  565.                     the background color reverts to the unarmed color.
  566.                     If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  567.                     used for the button face.
  568.  
  569.  
  570.         VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
  571.           The bindings for virtual keys are vendor specific.  For
  572.           information about bindings for virtual buttons and keys, see
  573.           VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))).
  574.  
  575.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  576.           CCCCoooorrrreeee((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeePPPPuuuusssshhhhBBBBuuuuttttttttoooonnnn((((3333XXXX)))), XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX)))),
  577.           XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee((((3333XXXX)))), and XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))).
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.      Page 9                                          (printed 4/30/98)
  592.  
  593.  
  594.  
  595.